Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.14.1 StructureDefinition: DAF-MedicationAdministration

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-medicationadministration

Defines constraints and extensions on the MedicationAdministration resource for use in querying and retrieving patient's medication information that was administered.

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.14.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from MedicationAdministration.

Summary

Mandatory: 4 elements
Must-Support: 17 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.medication[x] is sliced based on the value of @type
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration ∑ I0..*MedicationAdministrationAdministration of medication to a patient
mad-3: Reason given is only permitted if wasNotGiven is false
mad-2: Reason not given is only permitted if wasNotGiven is true
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑0..*IdentifierExternal identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... patient S ∑1..1Reference(DAF-Patient)Who received medication
... practitioner S ∑0..1Reference(DAF-Pract)Who administered substance
... encounter S ∑0..1Reference(DAF-Encounter)Encounter administered as part of
... prescription S ∑0..1Reference(DAF-MedicationOrder)Order administration performed against
... wasNotGiven ?! S∑0..1booleanTrue if medication not administered
... reasonNotGiven S ∑I0..1CodeableConceptReason administration not performed
Binding: Reason Medication Not Given Codes (example)
... reasonGiven ∑ I0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... effectiveTime[x] S ∑1..1dateTime, PeriodStart and end time of administration
... medication[x] ∑CodeableConcept, Reference(Medication)What was administered
Slice: Unordered, Open, by @type
... medication[x] ∑1..1CodeableConcept, Reference(Medication)What was administered
... medicationCodeableConcept S ∑1..1CodeableConceptWhat was administered
Binding: Medication Clinical Drug (RxNorm) (extensible)
... medicationReference S ∑1..1Reference(DAF-Medication)What was administered
... device S ∑0..*Reference(Device)Device used to administer
... note ∑0..1stringInformation about the administration
... dosage S ∑I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate[x]
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... text ∑0..1stringDosage Instructions
.... siteCodeableConcept S ∑0..1CodeableConceptBody site administered to
Binding: Vaccine Administered Body Site (preferred)
.... route S ∑0..1CodeableConceptPath of substance into body
Binding: Medication Route FDA Value Set (preferred)
.... method ∑0..1CodeableConceptHow drug was administered
Binding: (unbound) (example)
.... quantity S ∑0..1SimpleQuantityAmount administered in one dose
.... rate[x] S ∑0..1Ratio, RangeDose quantity per unit of time

doco Documentation for this format

todo

This structure is derived from MedicationAdministration.

Summary

Mandatory: 4 elements
Must-Support: 17 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.medication[x] is sliced based on the value of @type

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration ∑ I0..*MedicationAdministrationAdministration of medication to a patient
mad-3: Reason given is only permitted if wasNotGiven is false
mad-2: Reason not given is only permitted if wasNotGiven is true
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑0..*IdentifierExternal identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... patient S ∑1..1Reference(DAF-Patient)Who received medication
... practitioner S ∑0..1Reference(DAF-Pract)Who administered substance
... encounter S ∑0..1Reference(DAF-Encounter)Encounter administered as part of
... prescription S ∑0..1Reference(DAF-MedicationOrder)Order administration performed against
... wasNotGiven ?! S∑0..1booleanTrue if medication not administered
... reasonNotGiven S ∑I0..1CodeableConceptReason administration not performed
Binding: Reason Medication Not Given Codes (example)
... reasonGiven ∑ I0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... effectiveTime[x] S ∑1..1dateTime, PeriodStart and end time of administration
... medication[x] ∑CodeableConcept, Reference(Medication)What was administered
Slice: Unordered, Open, by @type
... medication[x] ∑1..1CodeableConcept, Reference(Medication)What was administered
... medicationCodeableConcept S ∑1..1CodeableConceptWhat was administered
Binding: Medication Clinical Drug (RxNorm) (extensible)
... medicationReference S ∑1..1Reference(DAF-Medication)What was administered
... device S ∑0..*Reference(Device)Device used to administer
... note ∑0..1stringInformation about the administration
... dosage S ∑I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate[x]
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... text ∑0..1stringDosage Instructions
.... siteCodeableConcept S ∑0..1CodeableConceptBody site administered to
Binding: Vaccine Administered Body Site (preferred)
.... route S ∑0..1CodeableConceptPath of substance into body
Binding: Medication Route FDA Value Set (preferred)
.... method ∑0..1CodeableConceptHow drug was administered
Binding: (unbound) (example)
.... quantity S ∑0..1SimpleQuantityAmount administered in one dose
.... rate[x] S ∑0..1Ratio, RangeDose quantity per unit of time

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.14.1.2 Terminology Bindings

PathNameConformanceValueSet
MedicationAdministration.language?extrequiredhttp://tools.ietf.org/html/bcp47
MedicationAdministration.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
MedicationAdministration.reasonNotGivenReason Medication Not Given CodesexampleReason Medication Not Given Codes
MedicationAdministration.reasonGivenReason Medication Given CodesexampleReason Medication Given Codes
MedicationAdministration.medicationCodeableConceptMedication Clinical Drug (RxNorm)extensibleMedication Clinical Drug (RxNorm)
MedicationAdministration.dosage.siteCodeableConceptVaccine Administered Body SitepreferredVaccine Administered Body Site
MedicationAdministration.dosage.routeMedication Route FDA Value SetpreferredMedication Route FDA Value Set
MedicationAdministration.dosage.method?extexample

D.14.1.3 Constraints

IdPathDetailsRequirements
mad-3MedicationAdministrationReason given is only permitted if wasNotGiven is false
XPath: not(exists(f:reasonGiven) and f:wasNotGiven/@value=true())
mad-2MedicationAdministrationReason not given is only permitted if wasNotGiven is true
XPath: not(exists(f:reasonNotGiven) and f:wasNotGiven/@value=false())
mad-1MedicationAdministration.dosageSHALL have at least one of dosage.quantity and dosage.rate[x]
XPath: exists(f:quantity) or exists(f:rateRatio) or exists(f:rateRange)
.